home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / qbbs / qmx_120.zip / SPAZ140X.ZOO / spaz.doc < prev    next >
Text File  |  1989-04-10  |  10KB  |  249 lines
  1.     -----------------------------------------------------------------------
  2.     SPAZ, Revision: 1.40                           Compiled: April 10, 1989
  3.  
  4.  
  5.     Dan Thomson   - FidoNet 1:163/216, BbsNet 86:6130/2, AlterNet 7:483/103
  6.     Andrew Farmer - FidoNet 1:163/115, BbsNet 86:6130/1, AlterNet 7:483/1.0
  7.  
  8.  
  9.     SPAZ is Copyright (c) MCMLXXXIX by Dan A. Thomson and Andrew D. Farmer.
  10.     Some additional Source Code was provided by Jeffrey Nonken of 1:103/522
  11.     -----------------------------------------------------------------------
  12.  
  13.     --------------------
  14.      THE LEGAL BUSINESS 
  15.     --------------------
  16.  
  17.     Spaz is guaranteed only to take up space on your hard disk.  Use it at
  18.     your own risk. No warranty is stated or implied. The authors shall not
  19.     be responsible for any damages resulting  from  it's  use, directly or
  20.     indirectly.
  21.  
  22.     Spaz is distributed as a Freely Available Copyrighted Program,  no fee
  23.     may be charged for distribution and the distribution archive is not to
  24.     be tampered with or altered in ANY way. 
  25.  
  26.     Spaz cannot be distributed in a modified form of any sort.
  27.  
  28.     Modified  Source  code, likewise, may NOT be distributed. If  you  are 
  29.     planning on porting the code to another operating system, or have code 
  30.     changes that you think are highly beneficial, then please contact  the 
  31.     authors directly for assistance or guidance.
  32.  
  33.     While Spaz is freely available  for use in non-corporate environments,
  34.     donations to the authors will always be gratefully accepted.
  35.  
  36.     The Authors may be contacted at the 2 Network Addresses listed on  the 
  37.     Mast Head, or by surface mail as follows:
  38.  
  39.                             P.O.Box 11087 Station H
  40.                             Nepean, Ontario
  41.                             K2H 7T8  CANADA
  42.  
  43.  
  44.     -----------------------------------------
  45.      THE DISTRIBUTION ARCHIVE (SPAZ_140.ZOO) 
  46.     -----------------------------------------
  47.  
  48.       This archive should have included the following files:
  49.  
  50.       SPAZ.DOC      -  The Documentation, you read it as we speak.
  51.       SPAZ.NEW      -  Changes since Revision 1.30.
  52.       SPAZ.COM      -  The Executable Program.
  53.       SPAZ.ASM      -  The Complete Assembler Source Code.
  54.       TECHNOTE.DOC  -  Technical notes on how Spaz works.
  55.  
  56.  
  57.     --------------
  58.      WHAT IT DOES 
  59.     --------------
  60.  
  61.     Spaz checks the archive to determine it's type, sorts the contents  by
  62.     date/time to ensure proper mail distribution and calls the appropriate
  63.     unarchive  program to extract the contents.  If you use the /N command
  64.     line option, the Sorting will NOT occur.
  65.  
  66.     Spaz is idealy suited to netmail  activities where it can  auto detect
  67.     incoming archives and extract them transparent to the calling program. 
  68.     
  69.     If the Archive is a standard (ARC compatible) Archive,  it will search
  70.     first for Pkxarc, then PkUnPak, Pak and ArcE in that order,  until  it
  71.     finds one on the path.  If you use the /A  command  line option,  then
  72.     ArcE will be used exclusively..no other program will  be searched for.
  73.  
  74.     If the Archive  contains Crushed files  (created by the Pak  Program),
  75.     then Spaz will not attempt to use any other Un-Archiver it will simply
  76.     search for and use Pak.
  77.  
  78.     If the  Archive was created by ZOO Spaz will search first for Looz and
  79.     then for Zoo, in that order, until it finds one on the path.
  80.  
  81.     If the  Archive was created by DWC, then Spaz will not attempt to  use
  82.     any other Un-Archiver it will simply search for and use DWC.
  83.      
  84.     If the Archive was created by PKZIP, then Spaz will not attempt to use
  85.     any other Un-Archiver it will simply search for and use PkZip.
  86.  
  87.     If the Archive was created by LHARC, then Spaz will not attempt to use
  88.     any other Un-Archiver it will simply search for and use LHARC.
  89.  
  90.     NOTE: SPAZ can be renamed to ARCE.COM to be used with OPUS 1.03, or it
  91.     can be used with Confmail by using the '/A SPAZ' option. If you rename
  92.     Spaz to ArcE be sure to have one of the other un-Archives on the Path,
  93.     (and  don't use the /A switch)  otherwise Spaz  would be calling ArcE,
  94.     which would be itself so you'd have an endless loop on your hands.
  95.  
  96.     SPAZ  can also be  used in a  batch file  (multitasking systems) as it
  97.     understands wildcard filenames.  This will remove the memory  overhead
  98.     of having Confmail shell to an Unarchiver. If used with the /d option,
  99.     spaz  will even delete the archives once processed (if the extract was
  100.     successful.
  101.      
  102.  
  103.     ------------------------------
  104.      DISK AND MEMORY REQUIREMENTS
  105.     ------------------------------
  106.  
  107.      1. DOS 2.00 or greater.
  108.      2. Enough disk space for a 2nd copy of the archive to be processed.
  109.      3. At least 1 available entry in the root directory of default drive.
  110.      4. At least 16K of RAM, plus room to load the Un-Archiver.
  111.      5. At least 2 available handles. (files= statement in config.sys).
  112.      6. For optimum use, the programs LOOZ or ZOO, PAK, and PKXARC, PKUNPAK
  113.         or ARCE  should be available on the path.  This will enable  you to 
  114.         un-compress a wide variety of archived files.
  115.  
  116.  
  117.     ---------------------
  118.      COMMAND LINE SYNTAX 
  119.     ---------------------
  120.  
  121.      Usage:  SPAZ [switches] Path/Archive [switches] [file...] [file...]
  122.  
  123.      Items enclosed in Square Brackets ([]) are entirely optional.
  124.  
  125.      Switches:
  126.  
  127.         *  -A
  128.  
  129.            Causes Spaz to search for ArcE (and ONLY ArcE) when  Un-Arciving
  130.            a standard Arc Compatible Archive.
  131.  
  132.         *  -D
  133.  
  134.            Causes Spaz to delete the Archive once Extract is successful. By
  135.            default it is NOT deleted.
  136.  
  137.         *  -F
  138.  
  139.            Causes Spaz to unpack ONLY Network Compressed Mail bundles in the
  140.            specified directory.  It will look for .MO?,.TU?, etc. files and
  141.            unpacked them all into the default directory.
  142.  
  143.            When  this switch is used the Archive name as specified  on  the
  144.            the command line should be the Path to your Inbound area,  NOT a
  145.            FileName.
  146.  
  147.            The -D (Delete) and -O (Overwrite) switches are forces ON by the
  148.            use of the -F switch.  Likewise the -N (NoSort) switch is forced
  149.            OFF.
  150.  
  151.            Due to the lack of an Overwrite mode in Looz, if this switch  is
  152.            used only Zoo will be called to process Zoo Archives, NEVER Looz.
  153.  
  154.         *  -Maddress
  155.  
  156.            Causes Spaz  to expand the  name of each file,  and try to gleen
  157.            the sending Net/Node address.  This switch will, or course, only
  158.            work properly on Compressed Mail bundles coming in over the Net.
  159.  
  160.            This switch must be followed by the 'address' pararmeter,  which
  161.            should be YOUR Net/Node address.
  162.  
  163.         *  -N 
  164.  
  165.            Causes  the Archive Sort  NOT to be  performed.  Since the  Sort
  166.            doesn't take up much more memory, it  is strongly suggested that
  167.            you DO NOT use this switch for NetMail related tasks.
  168.  
  169.         *  -O
  170.  
  171.            Causes Spaz to run in Overwrite Mode.   You will NOT be prompted
  172.            if a  file with the  same name as that  being extracted  already
  173.            exists in the directory,  the existing file will simply be over-
  174.            writen.
  175.  
  176.            Due to the lack of an Overwrite mode in Looz, if this switch  is
  177.            used only Zoo will be called to process Zoo Archives, NEVER Looz.
  178.  
  179.         *  -Q
  180.  
  181.            Cause Spaz to  run in Quiet mode,  does not display the run-time
  182.            configuration settings.
  183.  
  184.  
  185.      ----------
  186.       EXAMPLES
  187.      ----------
  188.  
  189.         *  Spaz -D 02986534.MO1
  190.  
  191.            This would sort, then Un-Archive the  bundle and delete  it when
  192.            finished.
  193.  
  194.         *  Spaz -N 02986534.MO1
  195.  
  196.            This  would Un-Archive the bundle but would not attempt  to sort
  197.            them and would not delete when finished.
  198.  
  199.         *  Spaz -D -N *.MO?
  200.  
  201.            This  would process all files  matching the wildcard  specs  but
  202.            would not attempt to sort them and would delete when finished.
  203.  
  204.         *  Spaz -N HELLO.ARC -Q *.TXT -O
  205.  
  206.            This would only extract files with an extension of TXT, it would
  207.            not sort the archive, it would operate in quiet mode & overwrite
  208.            mode would be used.
  209.  
  210.         *  Spaz -F D:\BINK\INBOUND
  211.  
  212.            This would Sort, extract from, then delete any file matching the
  213.            description of a Standard FidoNet<tm> Compressed Mail bundle.
  214.  
  215.         *  Spaz -F -M163/115 D:\BINK\INBOUND
  216.  
  217.            On my system (163/115) this would Sort, extract from then delete
  218.            any  file matching the description  of a FidoNet<tm>  Compressed
  219.            Mail bundle.  It would also tell me what node sent the bundle.
  220.  
  221.  
  222.         ---------------------=*[ IMPORTANT WARNING ]*=---------------------
  223.  
  224.         *  Spaz -D HELLO.ARC *.EXE
  225.  
  226.            This would only extract files with an extension of EXE, it would
  227.            then DELETE THE ENTIRE ARCHIVE. Be extreamly careful with the -D
  228.            switch if you are only extracting specific files.
  229.  
  230.  
  231.      ----------------
  232.       CLOSING NATTER 
  233.      ----------------
  234.  
  235.      I believe I have outlined everything in this documentation. I may have 
  236.      left something out, and probably have.
  237.  
  238.      If  you have any problems you can't fix or questions you can't  answer 
  239.      then  please contact me or Dan  via NetMail or  surface mail.  We will
  240.      always  do our best to support the software, but it is,  by definition
  241.      un-supported. We will answer queries as time allows, please be patient
  242.      when awaiting a reply.
  243.  
  244.      Andrew Farmer
  245.      Ottawa, Canada
  246.      April 10, 1989
  247.  
  248.      ----------------------------------------------------------------------
  249.